Saltar al contenido principal

1.4 Estilo y Convenciones PEP8

Cuando varias personas trabajan en un mismo proyecto, no basta con que el código funcione: también debe ser claro, legible y coherente. Para ello, en Python existe un documento llamado PEP8 (Python Enhancement Proposal 8), que define las reglas de estilo recomendadas para escribir programas en este lenguaje.

Aunque no son obligatorias, estas normas ayudan a mantener el código ordenado y facilitan que cualquier desarrollador pueda leerlo y entenderlo. En este punto repasaremos las más importantes.

1️⃣ Identación​

  • Usar 4 espacios por nivel de sangría.
  • No mezclar espacios y tabuladores.
# Correcto
if True:
    print("Bloque identado")

# Incorrecto
if True:
 print("Esto dará problemas")

2️⃣ Longitud de las líneas​

  • Se recomienda no superar los 79 caracteres por línea.
  • Para comentarios y docstrings, el límite es de 72 caracteres.
# Correcto: línea corta y clara
mensaje = "Este es un ejemplo de línea que cumple con la norma de PEP8."

3️⃣ Nombres de variables, funciones y clases​

  • Variables y funciones: en minúsculas, separadas por guiones bajos → mi_variable, calcular_suma().
  • Clases: estilo CamelCase, con mayúscula inicial → MiClase, VehiculoElectrico.
  • Constantes: en mayúsculas con guiones bajos → PI = 3.1416, MAX_INTENTOS = 3.

4️⃣ Espacios en blanco​

  • No añadir espacios innecesarios en expresiones o llamadas a funciones. Tampoco se deben colocar espacios al final de una línea.
# Correcto
resultado = a + b
lista = [1, 2, 3]

# Incorrecto
resultado=a+b
lista = [ 1, 2 , 3 ]

5️⃣ Comentarios y documentación​

  • Los comentarios deben ser claros y útiles, nunca repetir lo obvio.
  • Usar docstrings para describir funciones, clases y módulos.
def calcular_area(base, altura):
    """Devuelve el área de un triángulo dada la base y la altura"""
    return (base * altura) / 2

6️⃣ Importaciones​

  • Cada importación en una línea distinta.

  • El orden recomendado es:

    1. Librerías estándar de Python.
    2. Librerías externas.
    3. Módulos propios del proyecto.
# Correcto
import os
import sys

from datetime import datetime

7️⃣ Herramientas para comprobar el estilo​

Existen programas que permiten analizar automáticamente el código y comprobar si cumple con PEP8:

  • flake8
  • pylint
  • black (además, formatea el código automáticamente).

Por ejemplo, para instalar flake8:

pip install flake8
flake8 mi_programa.py